BaseSubsystem.ReadMemoryBool method

Reads a bit from the shared memory.

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

bool ReadMemoryBool(
       int byteOffset,
       int bitOffset
)

Function ReadMemoryBool(
       byteOffset As Integer,
       bitOffset As Integer
) As Boolean

Parameters

byteOffset

Type: int

Specifies a byte offset to the location to read. Indexes are zero based.

bitOffset

Type: int

Specifies a bit offset to the location to read a bit value.

Return value

Type: bool

Remarks

Since bit is too small to use for offset in the memory, the method provides Offset and BitOffset that allow you to specify the offset in byte and bit simultaneously.

Usable EtherCAT states

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP